fix: Match privateKey type in both JwtModuleOptions and JwtSignOptions #1192
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Dynamically sending a privateKey to jwtService.sign() (as opposed to using the JwtModule config) does not support passphrase encoded types (inconsistency in the Typescript interface).
Issue Number: N/A
What is the new behavior?
JwtSignOptions now supports passphrase encoded private key (using jwtService.sign()).
Does this PR introduce a breaking change?
Other information
jwt.Secret type includes
string | Buffer
as well as{ key: string | Buffer; passphrase: string }
.This change is required in order to enable using a
{key,passphrase}
-structuredprivateKey
in jwtService.sign() calls like it does in JwtModule.register().The use case is when you want to dynamically provide such key to the
sign
method (e.g. when each user/token has a different key pair).